/*
 * Copyright 2017-2020 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.management.endpoint.info;

import io.micronaut.context.env.PropertySource;
import io.micronaut.core.order.Ordered;
import org.reactivestreams.Publisher;

/**
 * <p>Describes an source of info that will be retrieved by the {@link InfoEndpoint}.</p>
 *
 * @author Zachary Klein
 * @since 1.0
 */
public interface InfoSource extends Ordered {

    /**
     * @return A publisher that returns a {@link PropertySource} containing data to be added to the endpoint response.
     */
    Publisher<PropertySource> getSource();

}
